Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add doc for diagnosing backpressure from Elasticsearch #4097

Merged
merged 9 commits into from
Aug 6, 2024
Merged

Add doc for diagnosing backpressure from Elasticsearch #4097

merged 9 commits into from
Aug 6, 2024

Conversation

1pkg
Copy link
Member

@1pkg 1pkg commented Jul 28, 2024 •
edited
Loading

This PR closes the issue elastic/apm-server#13403.

@1pkg 1pkg requested a review from a team July 28, 2024 00:40
@1pkg 1pkg self-assigned this Jul 28, 2024
@github-actions GitHub Actions
Copy link
Contributor

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@mergify Mergify
Copy link
Contributor

mergify bot commented Jul 28, 2024

This pull request does not have a backport label. Could you fix it @1pkg? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
    NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip Skip notification from the automated backport with mergify label Jul 28, 2024
carsonip
carsonip reviewed Jul 30, 2024
View reviewed changes
Copy link
Member

@carsonip carsonip left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

first pass

thanks! Looks good at a high level. Does it make sense to place this section in troubleshoot-apm.asciidoc?

docs/en/observability/apm/apm-performance-diagnostic.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/apm/apm-performance-diagnostic.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/apm/apm-performance-diagnostic.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/apm/apm-performance-diagnostic.asciidoc Outdated Show resolved Hide resolved
@1pkg 1pkg marked this pull request as ready for review July 30, 2024 22:12
@1pkg 1pkg requested a review from a team as a code owner July 30, 2024 22:12
@1pkg
Copy link
Member Author

1pkg commented Jul 30, 2024

first pass

thanks! Looks good at a high level. Does it make sense to place this section in troubleshoot-apm.asciidoc?

Thank you for the review @carsonip! I added the doc into troubleshooting section anchor per the recommendation.

@colleenmcginnis colleenmcginnis self-requested a review July 30, 2024 23:10
@1pkg 1pkg changed the title initial apm-es-backpressure doc draft Add doc for aiagnosing backpressure from Elasticsearch Jul 31, 2024
colleenmcginnis
colleenmcginnis reviewed Jul 31, 2024
View reviewed changes
Copy link
Contributor

@colleenmcginnis colleenmcginnis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor suggestions below!

docs/en/observability/apm/apm-performance-diagnostic.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/apm/apm-performance-diagnostic.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/apm/apm-performance-diagnostic.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/apm/apm-performance-diagnostic.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/apm/apm-performance-diagnostic.asciidoc Outdated Show resolved Hide resolved
carsonip
carsonip previously approved these changes Jul 31, 2024
View reviewed changes
Copy link
Member

@carsonip carsonip left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm content-wise. Please also follow through other review comments on language etc

@carsonip carsonip changed the title Add doc for aiagnosing backpressure from Elasticsearch Add doc for diagnosing backpressure from Elasticsearch Jul 31, 2024
carsonip
carsonip previously approved these changes Aug 1, 2024
View reviewed changes
Copy link
Member

@carsonip carsonip left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nits

docs/en/observability/apm/apm-performance-diagnostic.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/apm/apm-performance-diagnostic.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/apm/apm-performance-diagnostic.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/apm/apm-performance-diagnostic.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/apm/apm-performance-diagnostic.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/apm/apm-performance-diagnostic.asciidoc Outdated Show resolved Hide resolved
inge4pres
inge4pres reviewed Aug 1, 2024
View reviewed changes
Copy link
Contributor

@inge4pres inge4pres left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks 🙏🏼
mostly LGTM, a couple of nits

docs/en/observability/apm/apm-performance-diagnostic.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/apm/apm-performance-diagnostic.asciidoc Outdated Show resolved Hide resolved
@inge4pres inge4pres self-requested a review August 1, 2024 20:06
inge4pres
inge4pres previously approved these changes Aug 2, 2024
View reviewed changes
Copy link
Contributor

@inge4pres inge4pres left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! thanks 🙏🏼
Just one last spelling correction

carsonip
carsonip approved these changes Aug 2, 2024
View reviewed changes
Copy link
Member

@carsonip carsonip left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left one non-blocker comment in the thread about output.elasticsearch example, but lgtm overall.

carsonip
carsonip previously approved these changes Aug 5, 2024
View reviewed changes
docs/en/observability/apm/apm-performance-diagnostic.asciidoc Outdated Show resolved Hide resolved
@1pkg 1pkg requested review from carsonip and inge4pres August 5, 2024 21:42
carsonip
carsonip approved these changes Aug 6, 2024
View reviewed changes
Copy link
Member

@carsonip carsonip left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, thanks!

bmorelli25
bmorelli25 approved these changes Aug 6, 2024
View reviewed changes
Copy link
Member

@bmorelli25 bmorelli25 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks!

@bmorelli25 bmorelli25 added backport-8.15 Automated backport with mergify and removed backport-skip Skip notification from the automated backport with mergify labels Aug 6, 2024
@bmorelli25 bmorelli25 merged commit 406f676 into main Aug 6, 2024
8 checks passed
@bmorelli25 bmorelli25 deleted the apm-server-es-backpressure-docs branch August 6, 2024 15:58
mergify bot pushed a commit that referenced this pull request Aug 6, 2024
@1pkg @mergify
Add doc for diagnosing backpressure from Elasticsearch (#4097)
0c76a29 
* initial apm-es-backpressure doc draft

* address review comments

* fix internal doc references

* address review comments

* es backpressure troubleshoot doc fmt fix

* address comments

* fix doc typo

* add not recommended banner

(cherry picked from commit 406f676)
@mergify mergify bot mentioned this pull request Aug 6, 2024
Merged
bmorelli25 pushed a commit that referenced this pull request Aug 6, 2024
@mergify @1pkg @github-actions
[8.15](backport #4097) Add doc for diagnosing backpressure from Elast…
8c4c64d 
…icsearch (#4122)

* Add doc for diagnosing backpressure from Elasticsearch (#4097)

* initial apm-es-backpressure doc draft

* address review comments

* fix internal doc references

* address review comments

* es backpressure troubleshoot doc fmt fix

* address comments

* fix doc typo

* add not recommended banner

(cherry picked from commit 406f676)

* Delete docs/en/serverless directory

---------

Co-authored-by: Kostiantyn Masliuk <[email protected]>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@carsonip carsonip carsonip approved these changes

@bmorelli25 bmorelli25 bmorelli25 approved these changes

@colleenmcginnis colleenmcginnis Awaiting requested review from colleenmcginnis

@inge4pres inge4pres Awaiting requested review from inge4pres

Assignees

@1pkg 1pkg

Labels
backport-8.15 Automated backport with mergify
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@1pkg @inge4pres @bmorelli25 @carsonip @colleenmcginnis